Skip to content

docs: README.mdのルール説明を統一フォーマットに整理 #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 5, 2025

Conversation

azu
Copy link
Member

@azu azu commented Jul 5, 2025

概要

README.mdの「含まれるルール」セクションを統一フォーマットに整理しました。

変更内容

  • 各ルールの説明を統一フォーマットに変更:
    • ルール名
    • 説明
    • 検出される例
    • より自然な表現
    • オプション
  • 重複していたオプションの説明を整理し、各ルール内に統合
  • 全体の構成を見直し、読みやすさを向上

改善点

  • 各ルールの構造が統一され、理解しやすくなりました
  • 検出される問題と改善案が明確に示されるようになりました
  • オプションの説明が各ルールの文脈で理解できるようになりました

🤖 Generated with Claude Code

- 各ルールの説明を「ルール名」→「説明」→「検出される例」→「より自然な表現」→「オプション」の統一フォーマットに変更
- 重複していたオプションの説明を整理し、各ルール内に統合
- 全体の構成を見直し、読みやすさを向上

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@azu azu added the Type: Documentation Documentation only changes label Jul 5, 2025
@azu azu merged commit 7298ec0 into main Jul 5, 2025
4 checks passed
@azu azu deleted the docs/improve-readme-structure branch July 5, 2025 08:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Documentation only changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant